Skip to main content

Query Response

Description

This is the response to the PatientSearch Query.

API endpoints for Query Response

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/patient-search/query-response.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Intraconnects Unified Model

Event TypeIntraConnects ResponseData TypeAthena Response
ResponseMetaObject
ResponseMeta.DataModelStringPatientSearch
ResponseMeta.EventTypeStringResponse
ResponseMeta.RawArray
ResponseMeta.SourceString
ResponseMeta.Source.IDString
ResponseMeta.Source.NameString
ResponsePatientObject
ResponsePatient.Identifiers[]Array of Objects
ResponsePatient.Identifiers[].IDStringpatientid
ResponsePatient.Identifiers[].IDTypeStringEHRID
ResponsePatient.DemographicsObject
ResponsePatient.Demographics.FirstNameStringfirstname
ResponsePatient.Demographics.MiddleNameStringmiddlename
ResponsePatient.Demographics.LastNameStringlastname
ResponsePatient.Demographics.DOBStringdob
ResponsePatient.Demographics.SSNString
ResponsePatient.Demographics.SexStringsex
ResponsePatient.Demographics.RaceString
ResponsePatient.Demographics.IsHispanicBoolean
ResponsePatient.Demographics.ReligionString
ResponsePatient.Demographics.MaritalStatusString
ResponsePatient.Demographics.IsDeceasedBoolean
ResponsePatient.Demographics.DeathDateTimeString
ResponsePatient.Demographics.PhoneNumberObject
ResponsePatient.Demographics.PhoneNumber.HomeStringhomephone
ResponsePatient.Demographics.PhoneNumber.OfficeString
ResponsePatient.Demographics.PhoneNumber.MobileStringmobilephone
ResponsePatient.Demographics.EmailAddresses[]Array of Strings
ResponsePatient.Demographics.LanguageString
ResponsePatient.Demographics.Citizenship[]Array
ResponsePatient.Demographics.AddressObject
ResponsePatient.Demographics.Address.StreetAddressStringaddress
ResponsePatient.Demographics.Address.CityStringcity
ResponsePatient.Demographics.Address.StateStringstate
ResponsePatient.Demographics.Address.ZIPStringzip
ResponsePatient.Demographics.Address.CountyString
ResponsePatient.Demographics.Address.CountryStringcountry
ResponsePatient.Notes[]Array
ResponsePatient.Contacts[]Array of Objects
ResponsePatient.Contacts[].FirstNameString
ResponsePatient.Contacts[].MiddleNameString
ResponsePatient.Contacts[].LastNameString
ResponsePatient.Contacts[].AddressObject
ResponsePatient.Contacts[].Address.StreetAddressString
ResponsePatient.Contacts[].Address.CityString
ResponsePatient.Contacts[].Address.StateString
ResponsePatient.Contacts[].Address.ZIPString
ResponsePatient.Contacts[].Address.CountyString
ResponsePatient.Contacts[].Address.CountryString
ResponsePatient.Contacts[].PhoneNumberObject
ResponsePatient.Contacts[].PhoneNumber.HomeString
ResponsePatient.Contacts[].PhoneNumber.OfficeString
ResponsePatient.Contacts[].PhoneNumber.MobileString
ResponsePatient.Contacts[].RelationToPatientString
ResponsePatient.Contacts[].EmailAddresses[]Array of Strings
ResponsePatient.Contacts[].Roles[]Array
ResponsePatient.PCPObject
ResponsePatient.PCP.NPIString
ResponsePatient.PCP.IDString
ResponsePatient.PCP.IDTypeString
ResponsePatient.PCP.FirstNameString
ResponsePatient.PCP.LastNameString
ResponsePatient.PCP.Credentials[]Array
ResponsePatient.PCP.AddressObject
ResponsePatient.PCP.Address.StreetAddressString
ResponsePatient.PCP.Address.CityString
ResponsePatient.PCP.Address.StateString
ResponsePatient.PCP.Address.ZIPString
ResponsePatient.PCP.Address.CountyString
ResponsePatient.PCP.Address.CountryString
ResponsePatient.PCP.EmailAddresses[]Array of Strings
ResponsePatient.PCP.PhoneNumberObject
ResponsePatient.PCP.PhoneNumber.OfficeString
ResponsePatient.PCP.LocationObject
ResponsePatient.PCP.Location.TypeString
ResponsePatient.PCP.Location.FacilityString
ResponsePatient.PCP.Location.DepartmentNumeric
ResponsePatient.PCP.Location.RoomString
ResponsePatient.GuarantorObject
ResponsePatient.Guarantor.NumberString
ResponsePatient.Guarantor.FirstNameStringguarantorfirstname
ResponsePatient.Guarantor.MiddleNameStringguarantormiddlename
ResponsePatient.Guarantor.LastNameStringguarantorlastname
ResponsePatient.Guarantor.SSNStringguarantorssn
ResponsePatient.Guarantor.DOBStringguarantordob
ResponsePatient.Guarantor.SexStringguarantorsex
ResponsePatient.Guarantor.SpouseObject
ResponsePatient.Guarantor.Spouse.FirstNameString
ResponsePatient.Guarantor.Spouse.LastNameString
ResponsePatient.Guarantor.AddressObject
ResponsePatient.Guarantor.Address.StreetAddressStringguarantoraddress1
ResponsePatient.Guarantor.Address.CityStringguarantorcity
ResponsePatient.Guarantor.Address.StateStringguarantorstate
ResponsePatient.Guarantor.Address.ZIPStringguarantorzip
ResponsePatient.Guarantor.Address.CountyString
ResponsePatient.Guarantor.Address.CountryStringguarantorcountrycode3166
ResponsePatient.Guarantor.PhoneNumberObject
ResponsePatient.Guarantor.PhoneNumber.HomeStringguarantorhome
ResponsePatient.Guarantor.PhoneNumber.BusinessString
ResponsePatient.Guarantor.PhoneNumber.MobileStringguarantorphone
ResponsePatient.Guarantor.EmailAddresses[]Array of Stringsguarantoremail
ResponsePatient.Guarantor.TypeString
ResponsePatient.Guarantor.RelationToPatientString
ResponsePatient.Guarantor.EmployerObject
ResponsePatient.Guarantor.Employer.NameString
ResponsePatient.Guarantor.Employer.AddressObject
ResponsePatient.Guarantor.Employer.Address.StreetAddressString
ResponsePatient.Guarantor.Employer.Address.CityString
ResponsePatient.Guarantor.Employer.Address.StateString
ResponsePatient.Guarantor.Employer.Address.ZIPString
ResponsePatient.Guarantor.Employer.Address.CountyString
ResponsePatient.Guarantor.Employer.Address.CountryString
ResponsePatient.Guarantor.Employer.PhoneNumberString
ResponsePatient.Insurances[]Array of objects
ResponsePatient.Insurances[].PlanObject
ResponsePatient.Insurances[].Plan.IDString
ResponsePatient.Insurances[].Plan.IDTypeString
ResponsePatient.Insurances[].Plan.NameString
ResponsePatient.Insurances[].Plan.TypeString
ResponsePatient.Insurances[].MemberNumberString
ResponsePatient.Insurances[].CompanyObject
ResponsePatient.Insurances[].Company.IDString
ResponsePatient.Insurances[].Company.IDTypeString
ResponsePatient.Insurances[].Company.NameString
ResponsePatient.Insurances[].Company.AddressObject
ResponsePatient.Insurances[].Company.Address.StreetAddressString
ResponsePatient.Insurances[].Company.Address.CityString
ResponsePatient.Insurances[].Company.Address.StateString
ResponsePatient.Insurances[].Company.Address.ZIPString
ResponsePatient.Insurances[].Company.Address.CountyString
ResponsePatient.Insurances[].Company.Address.CountryString
ResponsePatient.Insurances[].Company.PhoneNumberString
ResponsePatient.Insurances[].GroupNumberString
ResponsePatient.Insurances[].GroupNameString
ResponsePatient.Insurances[].EffectiveDateString
ResponsePatient.Insurances[].ExpirationDateString
ResponsePatient.Insurances[].PolicyNumberString
ResponsePatient.Insurances[].PriorityString
ResponsePatient.Insurances[].AgreementTypeString
ResponsePatient.Insurances[].CoverageTypeString
ResponsePatient.Insurances[].InsuredObject
ResponsePatient.Insurances[].Insured.Identifiers[]Array
ResponsePatient.Insurances[].Insured.LastNameString
ResponsePatient.Insurances[].Insured.MiddleNameString
ResponsePatient.Insurances[].Insured.FirstNameString
ResponsePatient.Insurances[].Insured.SSNString
ResponsePatient.Insurances[].Insured.RelationshipString
ResponsePatient.Insurances[].Insured.DOBString
ResponsePatient.Insurances[].Insured.SexString
ResponsePatient.Insurances[].Insured.AddressObject
ResponsePatient.Insurances[].Insured.Address.StreetAddressString
ResponsePatient.Insurances[].Insured.Address.CityString
ResponsePatient.Insurances[].Insured.Address.StateString
ResponsePatient.Insurances[].Insured.Address.ZIPString
ResponsePatient.Insurances[].Insured.Address.CountyString
ResponsePatient.Insurances[].Insured.Address.CountryString